From: Daniel Campoverde [alx741] <alx741@riseup.net>
Date: Thu, 5 May 2016 00:38:50 +0000 (-0500)
Subject: Man page: Improve build command section
X-Git-Tag: archive/raspbian/0.35.0-2+rpi1~3^2^2^2^2^2^2^2~22^2~14^2~25^2~3
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/success//%22http:/www.example.com/cgi/success/?a=commitdiff_plain;h=d2d33a7f4ad8dfe00094360034a83918e5e3e899;p=cargo.git

Man page: Improve build command section
---

diff --git a/src/etc/cargo.1 b/src/etc/cargo.1
index c3e0043ea..300ccd17e 100644
--- a/src/etc/cargo.1
+++ b/src/etc/cargo.1
@@ -34,57 +34,105 @@ Configure coloring of output
 
 To get extended information about commands, run 'cargo help <command>'
 
-.TP
-\fBcargo build\fR
+.SS build
 Compile the current project
 .TP
-\fBcargo clean\fR
-Remove the target directory with build output
+\fB\-h, \-\-help\fR
+Print this message
 .TP
-\fBcargo doc\fR
-Build this project's and its dependencies' documentation
+\fB\-p\fR \fISPEC\fR, \fB\-\-package\fR \fISPEC ...\fR
+Package to build
 .TP
-\fBcargo init\fR
-Create a new cargo project in the current directory
+\fB\-j\fR \fIN\fR, \fB\-\-jobs\fR \fIN\fR
+The number of jobs to run in parallel
 .TP
-\fBcargo install\fR
-Install a Rust binary
+\fB\-\-lib\fR
+Build only this package's library
 .TP
-\fBcargo new\fR
-Create a new cargo project
+\fB\-\-bin\fR \fINAME\fR
+Build only the specified binary
 .TP
-\fBcargo run\fR
-Build and execute src/main.rs
+\fB\-\-example\fR \fINAME\fR
+Build only the specified example
 .TP
-\fBcargo test\fR
-Run the tests for the package
+\fB\-\-test\fR \fINAME\fR
+Build only the specified test target
 .TP
-\fBcargo bench\fR
-Run the benchmarks for the package
+\fB\-\-bench\fR \fINAME\fR
+Build only the specified benchmark target
 .TP
-\fBcargo update\fR
-Update dependencies in Cargo.lock
+\fB\-\-release\fR
+Build artifacts in release mode, with optimizations
 .TP
-\fBcargo package\fR
-Generate a source tarball for the current package
+\fB\-\-features\fR \fIFEATURES\fR
+Space-separated list of features to also build
 .TP
-\fBcargo publish\fR
-Package and upload this project to the registry
+\fB\-\-no-default-features\fR
+Do not build the `default` feature
 .TP
-\fBcargo uninstall\fR
-Remove a Rust binary
+\fB\-\-target\fR \fITRIPLE\fR
+Build for the target triple
 .TP
-\fBcargo search\fR
-Search registry for crates
+\fB\-\-manifest-path\fR \fIPATH\fR
+Path to the manifest to compile
+.TP
+\fB\-v, \-\-verbose\fR
+Use verbose output
+.TP
+\fB\-q, \-\-quiet\fR
+No output printed to stdout
 .TP
-\fBcargo version\fR
+\fB\-\-color\fR \fIWHEN\fR
+Coloring: auto, always, never
+
+.PP
+If the \fB--package\fR argument is given, then \fISPEC\fR is a package id
+specification which indicates which package should be built. If it is not given,
+then the current package is built. For more information on \fISPEC\fR and its
+format, see the `cargo help pkgid` command.
+
+Compilation can be configured via the use of profiles which are configured in
+the manifest. The default profile for this command is `dev`, but passing the
+\fB--release\fR flag will use the `release` profile instead.
+
+
+
+.SS clean
+Remove the target directory with build output
+.SS doc
+Build this project's and its dependencies' documentation
+.SS init
+Create a new cargo project in the current directory
+.SS install
+Install a Rust binary
+.SS new
+Create a new cargo project
+.SS run
+Build and execute src/main.rs
+.SS test
+Run the tests for the package
+.SS bench
+Run the benchmarks for the package
+.SS update
+Update dependencies in Cargo.lock
+.SS package
+Generate a source tarball for the current package
+.SS publish
+Package and upload this project to the registry
+.SS uninstall
+Remove a Rust binary
+.SS search
+Search registry for crates
+.SS version
 Print cargo's version and exit
 
 .SH FILES
 
 .TP
 ~/.cargo
-Directory in which Cargo stores repository data. Cargo can be instructed to use a .cargo subdirectory in a different location by setting the CARGO_HOME environment variable.
+Directory in which Cargo stores repository data. Cargo can be instructed to use
+a .cargo subdirectory in a different location by setting the CARGO_HOME
+environment variable.
 
 .SH "EXAMPLES"
 Build a local package and all of its dependencies